home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: Greatest Hits 1996 / Amiga Games: Greatest Hits 1996.iso / archive / userbox / publicdomain / superviewel.lha / SuperViewEL / SuperViewLibrary / Docs / SVSupport-Docs / ControlPad.doc next >
Text File  |  1996-06-18  |  4KB  |  96 lines
  1.  
  2.   The ControlPad-FileFormat V6.9 (10.9.95)
  3.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4.   Many SVObjects, SVDrivers and SVOperators have to handle globally set
  5.   preferences, which might also have to be handled and/or modified by
  6.   custom programs or SuperViewPrefs.
  7.  
  8.   To prevent multiple different ways of storing these preferences
  9.   data, I introduced a common standard FileFormat for such configuration
  10.   files: The ControlPad-FileFormat
  11.   (please read the notes under "Style Guide" below).
  12.  
  13.    - To allow easy reading and understanding of these Files, these are
  14.      stored in plain ASCII
  15.    - To prevent people from learning just another technique of configuring
  16.      files, these are constructed just like a kind of "Tooltype-Lists"
  17.    - a single ControlPad takes a full line of the File
  18.      and looks like that : <Name>=<Content> or <Keyword>
  19.      Content and Name may contain any ASCII characters except "=", because
  20.      the first "=", which is found, is used to separate the Name from the
  21.      Content in the line. A Keyword is anything, which does not contain
  22.      a "=" somwhere, but is not a comment.
  23.    - So all other special characters are possible (although you should
  24.      not make too much use of them for ergonomical reasons).
  25.    - it is supported to write as much comments to the files, as wished.
  26.      A comment line has to begin with "/" or ";" in its first column.
  27.      A totally blank line fits to the same category as "/" or ";" lines.
  28.    - any single line should not exceed 255 characters
  29.  
  30.  
  31.   Additional Notes
  32.   ~~~~~~~~~~~~~~~~
  33.   * Note, that comments are totally ignored by the Library functions, when
  34.     reading ControlPad-Files, and writing of comments is not supported.
  35.  
  36.     So do not add too much comments to your files, but on the other hand,
  37.     explain all of the Switches (and their default values) inside the
  38.     Doc-Files of your program to prevent a lack of information !
  39.  
  40.   * The SVSUP_FindControlPad() function is case-sensitive, so if nothing
  41.     else is specified, the ControlPad-entries are always also
  42.     case-sensitive. Case-Insensitive functions already have been added
  43.     (SVSUP_FindControlPadNoCase()) but are not used widely yet.
  44.  
  45.     By using GUI-based functions for ControlPad modifications which
  46.     prevent the user by changing them directly, you may be able to
  47.     avoid such conflicts.
  48.  
  49.  
  50.   "Style Guide"
  51.   ~~~~~~~~~~~~~
  52.   Common "style guide" rules (PLEASE NOTE) :
  53.  
  54.    - ControlPads should be located in "ENV:superview-library/"
  55.      and have the plain name of the SVDriver/SVObject/... plus
  56.      ".controlpad" as extension.
  57.      For Example a ControlPad for JPEG.svobject should be
  58.      named "ENV:superview-library/JPEG.controlpad".
  59.    - for boolean entries use <YES|NO> choices, not <TRUE/FALSE>
  60.      or just set single Keywords like "USE_..."
  61.    - use pregnant and verbose names for multiple-choices, like
  62.      <HUFF|LWZ|ENTROPY>, not <1|2|3>
  63.    - use short names and statements, not long and complicated ones :
  64.      "ColorDepth=24" instead of "Number_of_Colors=16.7_million"
  65.  
  66.  
  67.   Examples
  68.   ~~~~~~~~
  69.   In "Programmers/Example_Tools/ControlPad" you find some example
  70.   Source, which deals with ControlPads and should explain anything
  71.   you need to know about these.
  72.  
  73.   In addition to the supplied example Files there and to the SourceCode,
  74.   here are some examples of ControlPad-Files (---[...]--- marks the
  75.   beginning and the end: both lines are not part of the file):
  76.  
  77. ------------------------------ (1) JPEG.controlpad -------------------------
  78. /* Set the Input/Output ColorDepth for JPEG encoding/decoding (8/24) : */
  79. COLORDEPTH=8
  80.  
  81. /* Compress highly, but still with a good quality */
  82. QUANTIZATION=75
  83. ----------------------------------------------------------------------------
  84. ------------------------------ (2) LIBRARY.controlpad ----------------------
  85. // Set Default SVDriver
  86. DEFAULTSVDRIVER=AGA.svdriver
  87.  
  88. // Support any Datatypes
  89. ANYDATATYPES
  90. ----------------------------------------------------------------------------
  91. ------------------------------ (3) 24BitToHam.controlpad -------------------
  92. ; Set dithering mode
  93. DITHERMODE=HAM6_QUICK
  94. ----------------------------------------------------------------------------
  95.  
  96.